<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009-2010<a name="line.2"></a>
<FONT color="green">003</FONT>     Ubiquitous Knowledge Processing (UKP) Lab<a name="line.3"></a>
<FONT color="green">004</FONT>     Technische Universitaet Darmstadt<a name="line.4"></a>
<FONT color="green">005</FONT>     All rights reserved.<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.7"></a>
<FONT color="green">008</FONT>     you may not use this file except in compliance with the License.<a name="line.8"></a>
<FONT color="green">009</FONT>     You may obtain a copy of the License at<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<FONT color="green">014</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<FONT color="green">015</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<FONT color="green">016</FONT>     See the License for the specific language governing permissions and<a name="line.16"></a>
<FONT color="green">017</FONT>     limitations under the License.<a name="line.17"></a>
<FONT color="green">018</FONT>     */<a name="line.18"></a>
<FONT color="green">019</FONT>    package org.uimafit.component.initialize;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import static org.uimafit.factory.ExternalResourceFactory.createExternalResourceDependency;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    import java.lang.reflect.Field;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.HashMap;<a name="line.24"></a>
<FONT color="green">025</FONT>    import java.util.Map;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.uima.UimaContext;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.uima.resource.ExternalResourceDependency;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.uima.resource.Resource;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.uima.resource.ResourceAccessException;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.uima.resource.ResourceInitializationException;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.uima.resource.SharedResourceObject;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.uimafit.descriptor.ExternalResource;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.uimafit.descriptor.ExternalResourceLocator;<a name="line.34"></a>
<FONT color="green">035</FONT>    <a name="line.35"></a>
<FONT color="green">036</FONT>    /**<a name="line.36"></a>
<FONT color="green">037</FONT>     * Configurator class for {@link ExternalResource} annotations.<a name="line.37"></a>
<FONT color="green">038</FONT>     *<a name="line.38"></a>
<FONT color="green">039</FONT>     * @author Richard Eckart de Castilho<a name="line.39"></a>
<FONT color="green">040</FONT>     */<a name="line.40"></a>
<FONT color="green">041</FONT>    public class ExternalResourceInitializer {<a name="line.41"></a>
<FONT color="green">042</FONT>            /**<a name="line.42"></a>
<FONT color="green">043</FONT>             * Configure a component from the given context.<a name="line.43"></a>
<FONT color="green">044</FONT>             *<a name="line.44"></a>
<FONT color="green">045</FONT>             * @param &lt;T&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>             *            the component type.<a name="line.46"></a>
<FONT color="green">047</FONT>             * @param context<a name="line.47"></a>
<FONT color="green">048</FONT>             *            the UIMA context.<a name="line.48"></a>
<FONT color="green">049</FONT>             * @param object<a name="line.49"></a>
<FONT color="green">050</FONT>             *            the component.<a name="line.50"></a>
<FONT color="green">051</FONT>             * @throws ResourceInitializationException<a name="line.51"></a>
<FONT color="green">052</FONT>             *             if the external resource cannot be configured.<a name="line.52"></a>
<FONT color="green">053</FONT>             */<a name="line.53"></a>
<FONT color="green">054</FONT>            public static &lt;T&gt; void initialize(UimaContext context, T object)<a name="line.54"></a>
<FONT color="green">055</FONT>                            throws ResourceInitializationException {<a name="line.55"></a>
<FONT color="green">056</FONT>                    configure(context, object.getClass(), object.getClass(), object,<a name="line.56"></a>
<FONT color="green">057</FONT>                                    getResourceDeclarations(object.getClass()));<a name="line.57"></a>
<FONT color="green">058</FONT>            }<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>            /**<a name="line.60"></a>
<FONT color="green">061</FONT>             * Helper method for recursively configuring super-classes.<a name="line.61"></a>
<FONT color="green">062</FONT>             *<a name="line.62"></a>
<FONT color="green">063</FONT>             * @param &lt;T&gt;<a name="line.63"></a>
<FONT color="green">064</FONT>             *            the component type.<a name="line.64"></a>
<FONT color="green">065</FONT>             * @param context<a name="line.65"></a>
<FONT color="green">066</FONT>             *            the context containing the resource bindings.<a name="line.66"></a>
<FONT color="green">067</FONT>             * @param baseCls<a name="line.67"></a>
<FONT color="green">068</FONT>             *            the class on which configuration started.<a name="line.68"></a>
<FONT color="green">069</FONT>             * @param cls<a name="line.69"></a>
<FONT color="green">070</FONT>             *            the class currently being configured.<a name="line.70"></a>
<FONT color="green">071</FONT>             * @param object<a name="line.71"></a>
<FONT color="green">072</FONT>             *            the object being configured.<a name="line.72"></a>
<FONT color="green">073</FONT>             * @param dependencies<a name="line.73"></a>
<FONT color="green">074</FONT>             *            the dependencies.<a name="line.74"></a>
<FONT color="green">075</FONT>             * @throws ResourceInitializationException<a name="line.75"></a>
<FONT color="green">076</FONT>             *             if required resources could not be bound.<a name="line.76"></a>
<FONT color="green">077</FONT>             */<a name="line.77"></a>
<FONT color="green">078</FONT>            private static &lt;T&gt; void configure(UimaContext context, Class&lt;?&gt; baseCls, Class&lt;?&gt; cls,<a name="line.78"></a>
<FONT color="green">079</FONT>                            T object, Map&lt;String, ExternalResourceDependency&gt; dependencies)<a name="line.79"></a>
<FONT color="green">080</FONT>                            throws ResourceInitializationException {<a name="line.80"></a>
<FONT color="green">081</FONT>                    if (cls.getSuperclass() != null) {<a name="line.81"></a>
<FONT color="green">082</FONT>                            configure(context, baseCls, cls.getSuperclass(), object, dependencies);<a name="line.82"></a>
<FONT color="green">083</FONT>                    }<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>                    for (Field field : cls.getDeclaredFields()) {<a name="line.85"></a>
<FONT color="green">086</FONT>                            if (!field.isAnnotationPresent(ExternalResource.class)) {<a name="line.86"></a>
<FONT color="green">087</FONT>                                    continue;<a name="line.87"></a>
<FONT color="green">088</FONT>                            }<a name="line.88"></a>
<FONT color="green">089</FONT>    <a name="line.89"></a>
<FONT color="green">090</FONT>                            // Obtain the resource<a name="line.90"></a>
<FONT color="green">091</FONT>                            Object value;<a name="line.91"></a>
<FONT color="green">092</FONT>                            try {<a name="line.92"></a>
<FONT color="green">093</FONT>                                    value = context.getResourceObject(getKey(field));<a name="line.93"></a>
<FONT color="green">094</FONT>                            }<a name="line.94"></a>
<FONT color="green">095</FONT>                            catch (ResourceAccessException e) {<a name="line.95"></a>
<FONT color="green">096</FONT>                                    throw new ResourceInitializationException(e);<a name="line.96"></a>
<FONT color="green">097</FONT>                            }<a name="line.97"></a>
<FONT color="green">098</FONT>                            if (value instanceof ExternalResourceLocator) {<a name="line.98"></a>
<FONT color="green">099</FONT>                                    value = ((ExternalResourceLocator) value).getResource();<a name="line.99"></a>
<FONT color="green">100</FONT>                            }<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>                            // Sanity checks<a name="line.102"></a>
<FONT color="green">103</FONT>                            if (value == null &amp;&amp; isMandatory(field)) {<a name="line.103"></a>
<FONT color="green">104</FONT>                                    throw new ResourceInitializationException(new IllegalStateException(<a name="line.104"></a>
<FONT color="green">105</FONT>                                                    "Mandatory resource [" + getKey(field) + "] is not set on [" + baseCls<a name="line.105"></a>
<FONT color="green">106</FONT>                                                                    + "]"));<a name="line.106"></a>
<FONT color="green">107</FONT>                            }<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>                            // Now record the setting and optionally apply it to the given<a name="line.109"></a>
<FONT color="green">110</FONT>                            // instance.<a name="line.110"></a>
<FONT color="green">111</FONT>                            if (value != null) {<a name="line.111"></a>
<FONT color="green">112</FONT>                                    field.setAccessible(true);<a name="line.112"></a>
<FONT color="green">113</FONT>                                    try {<a name="line.113"></a>
<FONT color="green">114</FONT>                                            field.set(object, value);<a name="line.114"></a>
<FONT color="green">115</FONT>                                    }<a name="line.115"></a>
<FONT color="green">116</FONT>                                    catch (IllegalAccessException e) {<a name="line.116"></a>
<FONT color="green">117</FONT>                                            throw new ResourceInitializationException(e);<a name="line.117"></a>
<FONT color="green">118</FONT>                                    }<a name="line.118"></a>
<FONT color="green">119</FONT>                                    field.setAccessible(false);<a name="line.119"></a>
<FONT color="green">120</FONT>                            }<a name="line.120"></a>
<FONT color="green">121</FONT>                    }<a name="line.121"></a>
<FONT color="green">122</FONT>            }<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>            /**<a name="line.124"></a>
<FONT color="green">125</FONT>             * @param &lt;T&gt;<a name="line.125"></a>
<FONT color="green">126</FONT>             * @param cls<a name="line.126"></a>
<FONT color="green">127</FONT>             * @return<a name="line.127"></a>
<FONT color="green">128</FONT>             * @throws ResourceInitializationException<a name="line.128"></a>
<FONT color="green">129</FONT>             */<a name="line.129"></a>
<FONT color="green">130</FONT>            public static &lt;T&gt; Map&lt;String, ExternalResourceDependency&gt; getResourceDeclarations(Class&lt;?&gt; cls)<a name="line.130"></a>
<FONT color="green">131</FONT>                            throws ResourceInitializationException {<a name="line.131"></a>
<FONT color="green">132</FONT>                    Map&lt;String, ExternalResourceDependency&gt; deps = new HashMap&lt;String, ExternalResourceDependency&gt;();<a name="line.132"></a>
<FONT color="green">133</FONT>                    getResourceDeclarations(cls, cls, deps);<a name="line.133"></a>
<FONT color="green">134</FONT>                    return deps;<a name="line.134"></a>
<FONT color="green">135</FONT>            }<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>            private static &lt;T&gt; void getResourceDeclarations(Class&lt;?&gt; baseCls, Class&lt;?&gt; cls,<a name="line.137"></a>
<FONT color="green">138</FONT>                            Map&lt;String, ExternalResourceDependency&gt; dependencies)<a name="line.138"></a>
<FONT color="green">139</FONT>                            throws ResourceInitializationException {<a name="line.139"></a>
<FONT color="green">140</FONT>                    if (cls.getSuperclass() != null) {<a name="line.140"></a>
<FONT color="green">141</FONT>                            getResourceDeclarations(baseCls, cls.getSuperclass(), dependencies);<a name="line.141"></a>
<FONT color="green">142</FONT>                    }<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>                    for (Field field : cls.getDeclaredFields()) {<a name="line.144"></a>
<FONT color="green">145</FONT>                            if (!field.isAnnotationPresent(ExternalResource.class)) {<a name="line.145"></a>
<FONT color="green">146</FONT>                                    continue;<a name="line.146"></a>
<FONT color="green">147</FONT>                            }<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>                            if (dependencies.containsKey(getKey(field))) {<a name="line.149"></a>
<FONT color="green">150</FONT>                                    throw new ResourceInitializationException(new IllegalStateException("Key ["<a name="line.150"></a>
<FONT color="green">151</FONT>                                                    + getKey(field) + "] may only be used on a single field."));<a name="line.151"></a>
<FONT color="green">152</FONT>                            }<a name="line.152"></a>
<FONT color="green">153</FONT>    <a name="line.153"></a>
<FONT color="green">154</FONT>                            dependencies.put(<a name="line.154"></a>
<FONT color="green">155</FONT>                                            getKey(field),<a name="line.155"></a>
<FONT color="green">156</FONT>                                            createExternalResourceDependency(getKey(field), getApi(field),<a name="line.156"></a>
<FONT color="green">157</FONT>                                                            !isMandatory(field)));<a name="line.157"></a>
<FONT color="green">158</FONT>                    }<a name="line.158"></a>
<FONT color="green">159</FONT>            }<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>            /**<a name="line.161"></a>
<FONT color="green">162</FONT>             * Determine if the field is mandatory.<a name="line.162"></a>
<FONT color="green">163</FONT>             *<a name="line.163"></a>
<FONT color="green">164</FONT>             * @param field<a name="line.164"></a>
<FONT color="green">165</FONT>             *            the field to bind.<a name="line.165"></a>
<FONT color="green">166</FONT>             * @return whether the field is mandatory.<a name="line.166"></a>
<FONT color="green">167</FONT>             */<a name="line.167"></a>
<FONT color="green">168</FONT>            private static boolean isMandatory(Field field) {<a name="line.168"></a>
<FONT color="green">169</FONT>                    return field.getAnnotation(ExternalResource.class).mandatory();<a name="line.169"></a>
<FONT color="green">170</FONT>            }<a name="line.170"></a>
<FONT color="green">171</FONT>    <a name="line.171"></a>
<FONT color="green">172</FONT>            /**<a name="line.172"></a>
<FONT color="green">173</FONT>             * Get the binding key for the specified field. If no key is set, use the field class name as<a name="line.173"></a>
<FONT color="green">174</FONT>             * key.<a name="line.174"></a>
<FONT color="green">175</FONT>             *<a name="line.175"></a>
<FONT color="green">176</FONT>             * @param field<a name="line.176"></a>
<FONT color="green">177</FONT>             *            the field to bind.<a name="line.177"></a>
<FONT color="green">178</FONT>             * @return the binding key.<a name="line.178"></a>
<FONT color="green">179</FONT>             */<a name="line.179"></a>
<FONT color="green">180</FONT>            private static String getKey(Field field) {<a name="line.180"></a>
<FONT color="green">181</FONT>                    ExternalResource cpa = field.getAnnotation(ExternalResource.class);<a name="line.181"></a>
<FONT color="green">182</FONT>                    String key = cpa.key();<a name="line.182"></a>
<FONT color="green">183</FONT>                    if (key.length() == 0) {<a name="line.183"></a>
<FONT color="green">184</FONT>                            key = field.getType().getName();<a name="line.184"></a>
<FONT color="green">185</FONT>                    }<a name="line.185"></a>
<FONT color="green">186</FONT>                    return key;<a name="line.186"></a>
<FONT color="green">187</FONT>            }<a name="line.187"></a>
<FONT color="green">188</FONT>    <a name="line.188"></a>
<FONT color="green">189</FONT>            /**<a name="line.189"></a>
<FONT color="green">190</FONT>             * Get the type of class/interface a resource has to implement to bind to the annotated field.<a name="line.190"></a>
<FONT color="green">191</FONT>             * If no API is set, get it from the annotated field type.<a name="line.191"></a>
<FONT color="green">192</FONT>             *<a name="line.192"></a>
<FONT color="green">193</FONT>             * @param field<a name="line.193"></a>
<FONT color="green">194</FONT>             *            the field to bind.<a name="line.194"></a>
<FONT color="green">195</FONT>             * @return the API type.<a name="line.195"></a>
<FONT color="green">196</FONT>             */<a name="line.196"></a>
<FONT color="green">197</FONT>            @SuppressWarnings({ "unchecked", "rawtypes" })<a name="line.197"></a>
<FONT color="green">198</FONT>            private static Class&lt;? extends Resource&gt; getApi(Field field) {<a name="line.198"></a>
<FONT color="green">199</FONT>                    ExternalResource cpa = field.getAnnotation(ExternalResource.class);<a name="line.199"></a>
<FONT color="green">200</FONT>                    Class&lt;? extends Resource&gt; api = cpa.api();<a name="line.200"></a>
<FONT color="green">201</FONT>                    // If no api is specified, look at the annotated field<a name="line.201"></a>
<FONT color="green">202</FONT>                    if (api == Resource.class) {<a name="line.202"></a>
<FONT color="green">203</FONT>                            if (Resource.class.isAssignableFrom(field.getType())<a name="line.203"></a>
<FONT color="green">204</FONT>                                            || SharedResourceObject.class.isAssignableFrom(field.getType())) {<a name="line.204"></a>
<FONT color="green">205</FONT>                                    // If no API is set, check if the field type is already a resource type<a name="line.205"></a>
<FONT color="green">206</FONT>                                    api = (Class&lt;? extends Resource&gt;) field.getType();<a name="line.206"></a>
<FONT color="green">207</FONT>                            }<a name="line.207"></a>
<FONT color="green">208</FONT>                            else {<a name="line.208"></a>
<FONT color="green">209</FONT>                                    // If the field does not have a resource type, assume whatever. This allows to use<a name="line.209"></a>
<FONT color="green">210</FONT>                                    // a resource locator without having to specify the api parameter. It also allows<a name="line.210"></a>
<FONT color="green">211</FONT>                                    // to directly inject Java objects - yes, I know that Object does not extend<a name="line.211"></a>
<FONT color="green">212</FONT>                                    // Resource - REC, 2011-03-25<a name="line.212"></a>
<FONT color="green">213</FONT>                                    api = (Class) Object.class;<a name="line.213"></a>
<FONT color="green">214</FONT>                            }<a name="line.214"></a>
<FONT color="green">215</FONT>                    }<a name="line.215"></a>
<FONT color="green">216</FONT>                    return api;<a name="line.216"></a>
<FONT color="green">217</FONT>            }<a name="line.217"></a>
<FONT color="green">218</FONT>    }<a name="line.218"></a>




























































</PRE>
</BODY>
</HTML>
